/*
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public as published by
 * the Free Software Foundation, either version 3 of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.javaproxydiscoverer.workers;

import com.javaproxydiscoverer.ProxyConfiguration;

/**
 * All workers have to implement this.
 */
public interface Worker {
    /**
     * Performs the actual proxy discovery work.
     *
     * @return the detected proxy configuration or <code>null</code> if no proxy configuration was found.
     */
    ProxyConfiguration discoverProxy();

    /**
     * @return <code>true</code> if this worker supports the current running system, <code>false</code> otherwise.
     */
    boolean applies();
}
